home *** CD-ROM | disk | FTP | other *** search
/ Enigma Amiga Life 112 / EnigmaAmiga112CD.iso / dalla rivista / news / documentazione_flyer / flyerprivate.doc < prev   
Text File  |  1999-05-18  |  20KB  |  1,168 lines
  1. TABLE OF CONTENTS
  2.  
  3. flyer.library/AbortCmd
  4. flyer.library/AudioParams
  5. flyer.library/CacheTest
  6. flyer.library/CheckCmd
  7. flyer.library/CPUread
  8. flyer.library/CPUwrite
  9. flyer.library/DebugMode
  10. flyer.library/DSPboot
  11. flyer.library/FIRcustom
  12. flyer.library/FIRinit
  13. flyer.library/FIRmapRAM
  14. flyer.library/FIRquery
  15. flyer.library/FlyerChangeMode
  16. flyer.library/FlyerCmpGrips
  17. flyer.library/FlyerCopyGrip
  18. flyer.library/FlyerExamine
  19. flyer.library/FlyerFreeGrip
  20. flyer.library/FlyerLoadVideo
  21. flyer.library/FlyerLocate
  22. flyer.library/FlyerOptions
  23. flyer.library/FlyerParent
  24. flyer.library/FlyerSCSIdirect
  25. flyer.library/FlyerSelfTest
  26. flyer.library/FlyerWriteProt
  27. flyer.library/GetClrSeqError
  28. flyer.library/PgmFPGA
  29. flyer.library/ReadEEreg
  30. flyer.library/RunModule
  31. flyer.library/SBusRead
  32. flyer.library/SBusWrite
  33. flyer.library/SetClockGen
  34. flyer.library/SetNoMode
  35. flyer.library/SetPlayMode
  36. flyer.library/SetRecMode
  37. flyer.library/TeachFPGA
  38. flyer.library/WriteEEreg
  39. flyer.library/AbortCmd                                 flyer.library/AbortCmd
  40.  
  41.    NAME
  42.     AbortCmd -- abort a Flyer command then wait for completion
  43.  
  44.    SYNOPSIS
  45.     error = AbortCmd(ID)
  46.     D0               D0
  47.  
  48.     ULONG AbortCmd(ULONG);
  49.  
  50.    FUNCTION
  51.  
  52.    INPUTS
  53.     ID - returned from asyncronous command invocation
  54.  
  55.    RESULT
  56.     error - result code
  57.  
  58.    EXAMPLE
  59.  
  60.    NOTES
  61.  
  62.    BUGS
  63.  
  64.    SEE ALSO
  65.  
  66. flyer.library/AudioParams                           flyer.library/AudioParams
  67.  
  68.    NAME
  69.     AudioParams -- (not implemented)
  70.  
  71.    SYNOPSIS
  72.     error = AudioParams()
  73.     D0
  74.  
  75.     ULONG AudioParams(void);
  76.  
  77.    FUNCTION
  78.     (nothing)
  79.  
  80.    INPUTS
  81.  
  82.    RESULT
  83.  
  84.    EXAMPLE
  85.  
  86.    NOTES
  87.  
  88.    BUGS
  89.  
  90.    SEE ALSO
  91.  
  92. flyer.library/CacheTest                               flyer.library/CacheTest
  93.  
  94.    NAME
  95.     CacheTest -- Test CPU caching of Flyer shared RAM
  96.  
  97.    SYNOPSIS
  98.     error = CacheTest(board)
  99.     D0                D0
  100.  
  101.     ULONG CacheTest(UBYTE);
  102.  
  103.    FUNCTION
  104.  
  105.    INPUTS
  106.     board - specifies the Flyer board (0-3)
  107.  
  108.    RESULT
  109.     FERR_OKAY if alright, FERR_CMDFAILED if CPU is caching
  110.  
  111.    EXAMPLE
  112.  
  113.    NOTES
  114.  
  115.    BUGS
  116.  
  117.    SEE ALSO
  118.  
  119. flyer.library/CheckCmd                                 flyer.library/CheckCmd
  120.  
  121.    NAME
  122.     CheckCmd -- Check if a previously started command has completed
  123.  
  124.    SYNOPSIS
  125.     error = CheckCmd(ID)
  126.     D0               D0
  127.  
  128.     ULONG CheckCmd(ULONG);
  129.  
  130.    FUNCTION
  131.     Checks if a previously started command is complete.  If so,
  132.     wrap-up command entirely.  If not, copyback any data that might
  133.     need updated.
  134.  
  135.    INPUTS
  136.     ID - returned from asyncronous command invocation
  137.  
  138.    RESULT
  139.     error - FERR_BUSY if not done, else result code
  140.  
  141.    EXAMPLE
  142.  
  143.    NOTES
  144.  
  145.    BUGS
  146.  
  147.    SEE ALSO
  148.  
  149. flyer.library/CPUread                                   flyer.library/CPUread
  150.  
  151.    NAME
  152.     CpuRead -- Read data word from Flyer's memory space
  153.  
  154.    SYNOPSIS
  155.     error = CPUread(board,addr,dataptr)
  156.     D0              D0    A0   A1
  157.  
  158.     ULONG CPUread(UBYTE,ULONG,UWORD *);
  159.  
  160.    FUNCTION
  161.  
  162.    INPUTS
  163.     board - specifies the Flyer board (0-3)
  164.  
  165.     addr - memory address (in Flyer memory space)
  166.  
  167.     dataptr - pointer to variable to receive data read
  168.  
  169.    RESULT
  170.  
  171.    EXAMPLE
  172.  
  173.    NOTES
  174.  
  175.    BUGS
  176.  
  177.    SEE ALSO
  178.  
  179. flyer.library/CPUwrite                                 flyer.library/CPUwrite
  180.  
  181.    NAME
  182.     CpuWrite -- Write data to Flyer's memory space
  183.  
  184.    SYNOPSIS
  185.     error = CPUwrite(board,addr,data)
  186.     D0               D0    A0   D1
  187.  
  188.     ULONG CPUwrite(UBYTE,ULONG,UWORD);
  189.  
  190.    FUNCTION
  191.  
  192.    INPUTS
  193.     board - specifies the Flyer board (0-3)
  194.  
  195.     addr - memory address (in Flyer memory space)
  196.  
  197.     data - data to write
  198.  
  199.    RESULT
  200.  
  201.    EXAMPLE
  202.  
  203.    NOTES
  204.  
  205.    BUGS
  206.  
  207.    SEE ALSO
  208.  
  209. flyer.library/DebugMode                               flyer.library/DebugMode
  210.  
  211.    NAME
  212.     DebugMode -- Set Flyer Debug modes
  213.  
  214.    SYNOPSIS
  215.     error = DebugMode(board,flags)
  216.     D0                D0    D1
  217.  
  218.     ULONG DebugMode(UBYTE,ULONG);
  219.  
  220.    FUNCTION
  221.  
  222.    INPUTS
  223.     board - specifies the Flyer board (0-3)
  224.  
  225.     flags - new debugging flags (32)
  226.  
  227.    RESULT
  228.  
  229.    EXAMPLE
  230.  
  231.    NOTES
  232.  
  233.    BUGS
  234.  
  235.    SEE ALSO
  236.  
  237. flyer.library/DSPboot                                   flyer.library/DSPboot
  238.  
  239.    NAME
  240.     DSPboot - Download and run DSP program
  241.  
  242.    SYNOPSIS
  243.     error = DSPboot(board,length,data)
  244.     D0              D0    D1     A0
  245.  
  246.     ULONG DSPboot(UBYTE,ULONG,APTR);
  247.  
  248.    FUNCTION
  249.     Downloads supplied program into the DSP and executes it.
  250.  
  251.    INPUTS
  252.     board - specifies the Flyer board (0-3)
  253.  
  254.     length - length of data provided
  255.  
  256.     data - pointer to DSP program
  257.  
  258.    RESULT
  259.  
  260.    EXAMPLE
  261.  
  262.    NOTES
  263.  
  264.    BUGS
  265.  
  266.    SEE ALSO
  267.  
  268. flyer.library/FIRcustom                               flyer.library/FIRcustom
  269.  
  270.    NAME
  271.     FIRcustom - Define custom FIR coefficients
  272.  
  273.    SYNOPSIS
  274.     error = FIRcustom(board,prepost,scale,data)
  275.     D0                D0    D1      D2    A0
  276.  
  277.     ULONG FIRcustom(UBYTE,UBYTE,UWORD,UWORD *);
  278.  
  279.    FUNCTION
  280.     Defines custom FIR filter coefficients (either for pre-compensation
  281.     or post-compensation).  Each set contains 8 coefficients each.  A FIR
  282.     coefficient is a signed 10 bit number extended to a WORD.
  283.  
  284.    INPUTS
  285.     board - specifies the Flyer board (0-3)
  286.  
  287.     prepost - determines which type of set is specified:
  288.        0 - pre-compensation (recording)
  289.        1 - post-compensation (playback)
  290.  
  291.     scale - power-of-2 scaler value
  292.  
  293.     data - pointer to 8 consecutive WORDs
  294.  
  295.    RESULT
  296.  
  297.    EXAMPLE
  298.  
  299.    NOTES
  300.  
  301.    BUGS
  302.  
  303.    SEE ALSO
  304.  
  305. flyer.library/FIRinit                                   flyer.library/FIRinit
  306.  
  307.    NAME
  308.     FIRinit - Initialize FIR filter
  309.  
  310.    SYNOPSIS
  311.     error = FIRinit(board,ctrl0,ctrl1)
  312.     D0              D0    D1    D2
  313.  
  314.     ULONG FIRinit(UBYTE,UWORD,UWORD);
  315.  
  316.    FUNCTION
  317.     Initializes the FIR filter chip using the parameters provided.
  318.  
  319.    INPUTS
  320.     board - specifies the Flyer board (0-3)
  321.  
  322.     ctrl0,ctrl1 - chip specific register values
  323.  
  324.    RESULT
  325.  
  326.    EXAMPLE
  327.  
  328.    NOTES
  329.  
  330.    BUGS
  331.  
  332.    SEE ALSO
  333.  
  334. flyer.library/FIRmapRAM                               flyer.library/FIRmapRAM
  335.  
  336.    NAME
  337.     FIRmapRAM - Setup FIR map RAM
  338.  
  339.    SYNOPSIS
  340.     error = FIRmapRAM(board,bank,scale,shape)
  341.     D0                D0    D1   D2    D3
  342.  
  343.     ULONG FIRmapRAM(UBYTE,UBYTE,UBYTE,UBYTE);
  344.  
  345.    FUNCTION
  346.     Loads the FIR filter's map RAM with the correct table
  347.  
  348.    INPUTS
  349.     board - specifies the Flyer board (0-3)
  350.  
  351.     bank - FIR coefficient bank to load (0-7)
  352.  
  353.     scale - power-of-2 scaler (1,2,4)
  354.  
  355.     shape - 0 for linear, 2 for inverse sin
  356.  
  357.    RESULT
  358.  
  359.    EXAMPLE
  360.  
  361.    NOTES
  362.  
  363.    BUGS
  364.  
  365.    SEE ALSO
  366.  
  367. flyer.library/FIRquery                                 flyer.library/FIRquery
  368.  
  369.    NAME
  370.     FIRquery -- Read out FIR coefficient/scale presets
  371.  
  372.    SYNOPSIS
  373.     error = FIRquery(board,coefset,prepost,scaleptr,coefbuff)
  374.     D0               D0    D1      D2      A0       A1
  375.  
  376.     ULONG FIRquery(UBYTE,UBYTE,UBYTE,UWORD *,UWORD *);
  377.  
  378.    FUNCTION
  379.  
  380.    INPUTS
  381.     board - specifies the Flyer board (0-3)
  382.  
  383.     coefset - which set to read (0 - 31)
  384.  
  385.     prepost - (0=pre, 1=post)
  386.  
  387.     scaleptr - pointer to variable to receive scale value
  388.  
  389.     coefbuff - pointer to buffer to receive 8 coefficient words
  390.  
  391.    RESULT
  392.  
  393.    EXAMPLE
  394.  
  395.    NOTES
  396.  
  397.    BUGS
  398.  
  399.    SEE ALSO
  400.  
  401. flyer.library/FlyerChangeMode                   flyer.library/FlyerChangeMode
  402.  
  403.    NAME
  404.     FlyerChangeMode -- change access mode of grip object
  405.  
  406.    SYNOPSIS
  407.     error = FlyerChangeMode(flyervolume,grip,access)
  408.     D0                      A0          D0   D1
  409.  
  410.     ULONG FlyerChangeMode(struct FlyerVolume *,ULONG,UBYTE);
  411.  
  412.    FUNCTION
  413.  
  414.    INPUTS
  415.     volume - pointer to structure which specifies drive and path/name
  416.              of file
  417.  
  418.     grip - grip of file/dir
  419.  
  420.     access - new access mode
  421.  
  422.    RESULT
  423.  
  424.    EXAMPLE
  425.  
  426.    NOTES
  427.  
  428.    BUGS
  429.  
  430.    SEE ALSO
  431.  
  432. flyer.library/FlyerCmpGrips                       flyer.library/FlyerCmpGrips
  433.  
  434.    NAME
  435.     FlyerCmpGrips -- compare the similarity of two grips
  436.  
  437.    SYNOPSIS
  438.     error = FlyerCmpGrips(flyervolume,grip1,grip2)
  439.     D0                    A0          D0    D1
  440.  
  441.     ULONG FlyerCmpGrips(struct FlyerVolume *,ULONG,ULONG);
  442.  
  443.    FUNCTION
  444.  
  445.    INPUTS
  446.     volume - pointer to structure which specifies drive
  447.  
  448.     grip1 - first grip
  449.  
  450.     grip2 - second grip
  451.  
  452.    RESULT
  453.  
  454.    EXAMPLE
  455.  
  456.    NOTES
  457.  
  458.    BUGS
  459.  
  460.    SEE ALSO
  461.  
  462. flyer.library/FlyerCopyGrip                       flyer.library/FlyerCopyGrip
  463.  
  464.    NAME
  465.     FlyerCopyGrip -- make a clone of a grip
  466.  
  467.    SYNOPSIS
  468.     error = FlyerCopyGrip(flyervolume,grip,gripptr)
  469.     D0                    A0          D0   A1
  470.  
  471.     ULONG FlyerCopyGrip(struct FlyerVolume *,ULONG,ULONG *);
  472.  
  473.    FUNCTION
  474.  
  475.    INPUTS
  476.     volume - pointer to structure which specifies drive
  477.  
  478.     grip - grip to copy
  479.  
  480.     gripptr - pointer to variable to receive copied grip
  481.  
  482.    RESULT
  483.  
  484.    EXAMPLE
  485.  
  486.    NOTES
  487.  
  488.    BUGS
  489.  
  490.    SEE ALSO
  491.  
  492. flyer.library/FlyerExamine                         flyer.library/FlyerExamine
  493.  
  494.    NAME
  495.     FlyerExamine -- return information about a file or directory
  496.  
  497.    SYNOPSIS
  498.     error = FlyerExamine(flyervolume,grip,objinfoptr)
  499.     D0                   A0          D0   A1
  500.  
  501.     ULONG FlyerExamine(struct FlyerVolume *,ULONG,struct ClipInfo *);
  502.  
  503.    FUNCTION
  504.  
  505.    INPUTS
  506.     volume - pointer to structure which specifies drive
  507.  
  508.     grip - grip of file/dir
  509.  
  510.     objinfoptr - Pointer to ClipInfo structure to receive info
  511.  
  512.    RESULT
  513.  
  514.    EXAMPLE
  515.  
  516.    NOTES
  517.  
  518.    BUGS
  519.  
  520.    SEE ALSO
  521.  
  522. flyer.library/FlyerFreeGrip                       flyer.library/FlyerFreeGrip
  523.  
  524.    NAME
  525.     FlyerFreeGrip -- free a grip obtained earlier
  526.  
  527.    SYNOPSIS
  528.     error = FlyerFreeGrip(flyervolume,grip)
  529.     D0                    A0          D0
  530.  
  531.     ULONG FlyerFreeGrip(struct FlyerVolume *,ULONG);
  532.  
  533.    FUNCTION
  534.  
  535.    INPUTS
  536.     volume - pointer to structure which specifies drive
  537.  
  538.     grip - grip to free
  539.  
  540.    RESULT
  541.  
  542.    EXAMPLE
  543.  
  544.    NOTES
  545.  
  546.    BUGS
  547.  
  548.    SEE ALSO
  549.  
  550. flyer.library/FlyerLoadVideo                     flyer.library/FlyerLoadVideo
  551.  
  552.    NAME
  553.     FlyerLoadVideo -- force video data into output buffer
  554.  
  555.    SYNOPSIS
  556.     error = FlyerLoadVideo(board,addr,size)
  557.     D0                    D0     A0   D1
  558.  
  559.     ULONG FlyerLoadVideo(UBYTE,APTR,ULONG);
  560.  
  561.    FUNCTION
  562.  
  563.    INPUTS
  564.     board - specifies the Flyer board (0-3)
  565.  
  566.     addr - pointer to video data to load
  567.  
  568.     size - size of data (in bytes)
  569.  
  570.    RESULT
  571.  
  572.    EXAMPLE
  573.  
  574.    NOTES
  575.  
  576.    BUGS
  577.  
  578.    SEE ALSO
  579.  
  580. flyer.library/FlyerLocate                           flyer.library/FlyerLocate
  581.  
  582.    NAME
  583.     FlyerLocate -- obtain a "grip" on a file/dir, from a grip/name spec
  584.  
  585.    SYNOPSIS
  586.     error = FlyerLocate(clipaction)
  587.     D0                  A0
  588.  
  589.     ULONG FlyerLocate(struct ClipAction *);
  590.  
  591.    FUNCTION
  592.  
  593.    INPUTS
  594.     clipaction - specifies the path/name of the file
  595.  
  596.    RESULT
  597.  
  598.    EXAMPLE
  599.  
  600.    NOTES
  601.  
  602.    BUGS
  603.  
  604.    SEE ALSO
  605.  
  606. flyer.library/FlyerOptions                         flyer.library/FlyerOptions
  607.  
  608.    NAME
  609.     FlyerOptions -- Get/Set Flyer option flags
  610.  
  611.    SYNOPSIS
  612.     error = FlyerOptions(board,setflag,options)
  613.     D0                   D0    D1      A0
  614.  
  615.     ULONG FlyerOptions(UBYTE,UBYTE,ULONG *);
  616.  
  617.    FUNCTION
  618.  
  619.    INPUTS
  620.     board - specifies the Flyer board (0-3)
  621.  
  622.     setflag - 0=read flags, 1=set flags
  623.  
  624.     options - pointer to variable which contains options flags (for
  625.               both testing and setting)
  626.  
  627.    RESULT
  628.  
  629.    EXAMPLE
  630.  
  631.    NOTES
  632.  
  633.    BUGS
  634.  
  635.    SEE ALSO
  636.  
  637. flyer.library/FlyerParent                           flyer.library/FlyerParent
  638.  
  639.    NAME
  640.     FlyerParent -- get a grip on the parent of the grip/file specified
  641.  
  642.    SYNOPSIS
  643.     error = FlyerParent(flyervolume,grip,newgripptr,blockptr)
  644.     D0                  A0          D0   A1         A2
  645.  
  646.     ULONG FlyerParent(struct FlyerVolume *,ULONG,ULONG *,ULONG *);
  647.  
  648.    FUNCTION
  649.  
  650.    INPUTS
  651.     volume - pointer to structure which specifies drive
  652.  
  653.     grip1 - grip of file/dir
  654.  
  655.     newgripptr - pointer to variable to receive the grip on the parent
  656.  
  657.     blockptr - pointer to var to receive block which identifies parent
  658.  
  659.    RESULT
  660.  
  661.    EXAMPLE
  662.  
  663.    NOTES
  664.  
  665.    BUGS
  666.  
  667.    SEE ALSO
  668.  
  669. flyer.library/FlyerSCSIdirect                   flyer.library/FlyerSCSIdirect
  670.  
  671.    NAME
  672.     FlyerSCSIdirect -- standard "SCSI direct" channel to Flyer drives
  673.  
  674.    SYNOPSIS
  675.     error = FlyerSCSIdirect(board,unit,scsiinfo,structlen)
  676.     D0                      D0    D1   A0       D2
  677.  
  678.     ULONG FlyerSCSIdirect(UBYTE,UBYTE,struct SCSICmd *,UBYTE);
  679.  
  680.    FUNCTION
  681.  
  682.    INPUTS
  683.     board - specifies the Flyer board (0-3)
  684.  
  685.     unit - SCSI unit number
  686.  
  687.     scsiinfo - pointer to SCSICmd structure
  688.  
  689.     structlen - length of SCSICmd structure provided
  690.  
  691.    RESULT
  692.  
  693.    EXAMPLE
  694.  
  695.    NOTES
  696.  
  697.    BUGS
  698.  
  699.    SEE ALSO
  700.  
  701. flyer.library/FlyerSelfTest                       flyer.library/FlyerSelfTest
  702.  
  703.    NAME
  704.     FlyerSelfTest -- Run Flyer self-test tool
  705.  
  706.    SYNOPSIS
  707.     error = FlyerSelfTest(board,test,arg1,arg2,result)
  708.     D0                    D0    D1   D2   D3   A0
  709.  
  710.     ULONG FlyerSelfTest(UBYTE,UBYTE,ULONG,ULONG,ULONG *);
  711.  
  712.    FUNCTION
  713.  
  714.    INPUTS
  715.     board - specifies the Flyer board (0-3)
  716.  
  717.     test - test code to perform
  718.  
  719.     arg1 - first arg for test
  720.  
  721.     arg2 - second arg for test
  722.  
  723.     result - pointer to variable to receive test results
  724.  
  725.    RESULT
  726.  
  727.    EXAMPLE
  728.  
  729.    NOTES
  730.  
  731.    BUGS
  732.  
  733.    SEE ALSO
  734.  
  735. flyer.library/FlyerWriteProt                     flyer.library/FlyerWriteProt
  736.  
  737.    NAME
  738.     FlyerWriteProt -- set/test write protect status of drive
  739.  
  740.    SYNOPSIS
  741.     error = FlyerWriteProt(flyervolume,setval,setflag,checkvalptr)
  742.     D0                     A0          D0     D1      A1
  743.  
  744.     ULONG FlyerWriteProt(struct FlyerVolume *,UBYTE,UBYTE,UBYTE *);
  745.  
  746.    FUNCTION
  747.     This function can be used to test or set the write-protect status of
  748.     a Flyer drive.  The drive is specified using a volume name or
  749.     SCSIdrive value in the volume structure.
  750.  
  751.     A state of 0 means "write-enabled", 1 means "write-protected"
  752.  
  753.    INPUTS
  754.     volume - pointer to structure which specifies drive and path/name of
  755.              file
  756.  
  757.     setval - value to use (if 'setflag' is true)
  758.  
  759.     setflag - 0=test state, 1=set state (to 'setval')
  760.  
  761.     checkvalptr - pointer to variable to receive protect state if just
  762.                   testing
  763.  
  764.    RESULT
  765.  
  766.    EXAMPLE
  767.  
  768.    NOTES
  769.  
  770.    BUGS
  771.  
  772.    SEE ALSO
  773.  
  774. flyer.library/GetClrSeqError                     flyer.library/GetClrSeqError
  775.  
  776.    NAME
  777.     GetClrSeqErr -- Check or clear Flyer sequencing error register
  778.  
  779.    SYNOPSIS
  780.     error = GetClrSeqError(board,flag,doneptr,userIDptr,moreinfoptr)
  781.     D0                     D0    D1   A0      A1        A2
  782.  
  783.     ULONG GetClrSeqError(UBYTE,UBYTE,UBYTE *,ULONG *,ULONG *);
  784.  
  785.    FUNCTION
  786.     This is primarily used to check for timing errors during
  787.     sequencing.  It is capable of returning the exact event that
  788.     failed to sequence, and an argument that gives detailed info
  789.     about the returned error.
  790.  
  791.     This function takes very little time to execute, and does not
  792.     involve the Flyer CPU at all, so sequencing performance is not
  793.     affected.
  794.  
  795.    INPUTS
  796.     board - specifies the Flyer board (0-3)
  797.  
  798.     flag - 0=get error, 1=clear error
  799.  
  800.     doneptr - pointer to a variable to receive the "done" status
  801.                  (0 = still playing/recording, 1 = done)
  802.  
  803.     userIDptr - pointer to a variable to receive the userID of the
  804.                 event in the sequence that failed.  This number is
  805.                 private to the application that downloaded the
  806.                 sequence.  Set to NULL to not use this feature.
  807.  
  808.     moreinfoptr - pointer to a variable to receive details about the
  809.                   error, if any.  This may be used to give the exact
  810.                   number of fields an event was late, or how many fields
  811.                   were dropped, for example.  Set to NULL if not used.
  812.  
  813.    RESULT
  814.  
  815.    EXAMPLE
  816.  
  817.    NOTES
  818.     Certain Flyer functions may clear this error, such as PlaySequence
  819.     and FlyerRecord.
  820.  
  821.     On a "get" operation, always updates variables to whom pointers are
  822.     provided, regardless of the type of error code returned (or none)
  823.  
  824.    BUGS
  825.  
  826.    SEE ALSO
  827.  
  828. flyer.library/PgmFPGA                                   flyer.library/PgmFPGA
  829.  
  830.    NAME
  831.     PgmFPGA - Download and program one of the Flyer's FPGA chips.
  832.  
  833.    SYNOPSIS
  834.     error = PgmFPGA(board,chip,length,data,rev)
  835.     D0              D0    D1   D2     A0   D3
  836.  
  837.     ULONG PgmFPGA(UBYTE,UBYTE,ULONG,APTR,UBYTE);
  838.  
  839.    FUNCTION
  840.     Downloads binary chip data and programs the selected FPGA.  If the
  841.     chip fails to program properly, it is reset and this command returns
  842.     FERR_CMDFAILED.
  843.  
  844.    INPUTS
  845.     board - specifies the Flyer board (0-3)
  846.  
  847.     chip - Flyer chip number:
  848.        1 - Skew
  849.        2 - Timer/Router
  850.        3 - Pcoder 1
  851.        4 - Pcoder 2
  852.        5 - Mcoder 1
  853.        6 - Mcoder 2
  854.        7 - DMA controller
  855.        8 - Audio DMA interface
  856.        9 - Aligner
  857.  
  858.     length - length of data provided
  859.  
  860.     data - pointer to binary data
  861.  
  862.     revision - rev code for chip file
  863.  
  864.    RESULT
  865.  
  866.    EXAMPLE
  867.  
  868.    NOTES
  869.  
  870.    BUGS
  871.  
  872.    SEE ALSO
  873.  
  874. flyer.library/ReadEEreg                               flyer.library/ReadEEreg
  875.  
  876.    NAME
  877.     ReadEEreg -- Read from Flyer's EEPROM
  878.  
  879.    SYNOPSIS
  880.     error = ReadEEreg(board,addr,dataptr)
  881.     D0                D0    D1   A0
  882.  
  883.     ULONG ReadEEreg(UBYTE,UBYTE,UWORD *);
  884.  
  885.    FUNCTION
  886.  
  887.    INPUTS
  888.     board - specifies the Flyer board (0-3)
  889.  
  890.     addr - address in EEPROM (0 - 63)
  891.  
  892.     dataptr - pointer to variable to receive data word read from EEPROM
  893.  
  894.    RESULT
  895.  
  896.    EXAMPLE
  897.  
  898.    NOTES
  899.  
  900.    BUGS
  901.  
  902.    SEE ALSO
  903.  
  904. flyer.library/RunModule                               flyer.library/RunModule
  905.  
  906.    NAME
  907.     RunModule -- load/call supplied software module on Flyer processor
  908.  
  909.    SYNOPSIS
  910.     error = RunModule(board,length,data,ID,argc,argv)
  911.     D0                D0    D1     A0   A1 D2   A2
  912.  
  913.     ULONG RunModule(UBYTE,ULONG,APTR,ULONG *,UWORD,ULONG *);
  914.  
  915.    FUNCTION
  916.  
  917.    INPUTS
  918.     board - specifies the Flyer board (0-3)
  919.  
  920.     length - length of code module in bytes
  921.  
  922.     data - pointer to code module data
  923.  
  924.     ID - returned from asyncronous command invocation (or 0 for sync)
  925.  
  926.     argc - number of arguments supplied
  927.  
  928.     argv - pointer to first argument supplied
  929.  
  930.    RESULT
  931.  
  932.    EXAMPLE
  933.  
  934.    NOTES
  935.  
  936.    BUGS
  937.  
  938.    SEE ALSO
  939.  
  940. flyer.library/SBusRead                                 flyer.library/SBusRead
  941.  
  942.    NAME
  943.     SBusRead -- Read data from Flyer's internal fast sbus
  944.  
  945.    SYNOPSIS
  946.     error = SBusRead(board,addr,dataptr)
  947.     D0               D0    D1   A0
  948.  
  949.     ULONG SBusRead(UBYTE,UBYTE,UBYTE *);
  950.  
  951.    FUNCTION
  952.  
  953.    INPUTS
  954.     board - specifies the Flyer board (0-3)
  955.  
  956.     addr - sbus address
  957.  
  958.     dataptr - pointer to variable to receive data
  959.  
  960.    RESULT
  961.  
  962.    EXAMPLE
  963.  
  964.    NOTES
  965.  
  966.    BUGS
  967.  
  968.    SEE ALSO
  969.  
  970. flyer.library/SBusWrite                               flyer.library/SBusWrite
  971.  
  972.    NAME
  973.     SBusWrite -- Write data to Flyer's internal fast sbus
  974.  
  975.    SYNOPSIS
  976.     error = SBusWrite(board,addr,data)
  977.     D0                D0    D1   D2
  978.  
  979.     ULONG SBusWrite(UBYTE,UBYTE,UBYTE);
  980.  
  981.    FUNCTION
  982.  
  983.    INPUTS
  984.     board - specifies the Flyer board (0-3)
  985.  
  986.     addr - sbus address
  987.  
  988.     data - data to write
  989.  
  990.    RESULT
  991.  
  992.    EXAMPLE
  993.  
  994.    NOTES
  995.  
  996.    BUGS
  997.  
  998.    SEE ALSO
  999.  
  1000. flyer.library/SetClockGen                           flyer.library/SetClockGen
  1001.  
  1002.    NAME
  1003.     SetClockGen -- Set speed of 1 of the Flyer's 4 clock generators
  1004.  
  1005.    SYNOPSIS
  1006.     error = SetClockGen(board,clock,speed)
  1007.     D0                  D0    D1    D2
  1008.  
  1009.     ULONG SetClockGen(UBYTE,UBYTE,ULONG);
  1010.  
  1011.    FUNCTION
  1012.  
  1013.    INPUTS
  1014.     board - specifies the Flyer board (0-3)
  1015.  
  1016.     clock - code for which clock to set
  1017.  
  1018.     speed - desired clock speed (in Hz)
  1019.  
  1020.    RESULT
  1021.  
  1022.    EXAMPLE
  1023.  
  1024.    NOTES
  1025.  
  1026.    BUGS
  1027.  
  1028.    SEE ALSO
  1029.  
  1030. flyer.library/SetNoMode                               flyer.library/SetNoMode
  1031.  
  1032.    NAME
  1033.     SetNoMode -- Put Flyer in no play/record mode
  1034.  
  1035.    SYNOPSIS
  1036.     error = SetNoMode(board)
  1037.     D0                D0
  1038.  
  1039.     ULONG SetNoMode(UBYTE);
  1040.  
  1041.    FUNCTION
  1042.  
  1043.    INPUTS
  1044.     board - specifies the Flyer board (0-3)
  1045.  
  1046.    RESULT
  1047.  
  1048.    EXAMPLE
  1049.  
  1050.    NOTES
  1051.  
  1052.    BUGS
  1053.  
  1054.    SEE ALSO
  1055.  
  1056. flyer.library/SetPlayMode                           flyer.library/SetPlayMode
  1057.  
  1058.    NAME
  1059.     SetPlayMode -- Put Flyer in playback mode
  1060.  
  1061.    SYNOPSIS
  1062.     error = SetPlayMode(board)
  1063.     D0                  D0
  1064.  
  1065.     ULONG SetPlayMode(UBYTE);
  1066.  
  1067.    FUNCTION
  1068.  
  1069.    INPUTS
  1070.     board - specifies the Flyer board (0-3)
  1071.  
  1072.    RESULT
  1073.  
  1074.    EXAMPLE
  1075.  
  1076.    NOTES
  1077.  
  1078.    BUGS
  1079.  
  1080.    SEE ALSO
  1081.  
  1082. flyer.library/SetRecMode                             flyer.library/SetRecMode
  1083.  
  1084.    NAME
  1085.     SetRecMode -- Put Flyer in record mode
  1086.  
  1087.    SYNOPSIS
  1088.     error = SetRecMode(board)
  1089.     D0                 D0
  1090.  
  1091.     ULONG SetRecMode(UBYTE);
  1092.  
  1093.    FUNCTION
  1094.  
  1095.    INPUTS
  1096.     board - specifies the Flyer board (0-3)
  1097.  
  1098.    RESULT
  1099.  
  1100.    EXAMPLE
  1101.  
  1102.    NOTES
  1103.  
  1104.    BUGS
  1105.  
  1106.    SEE ALSO
  1107.  
  1108. flyer.library/TeachFPGA                               flyer.library/TeachFPGA
  1109.  
  1110.    NAME
  1111.     TeachFPGA -- Teach flyer.library an FPGA chip definition
  1112.  
  1113.    SYNOPSIS
  1114.     error = TeachFPGA(chip,length,data)
  1115.     D0                D0   D1     D2
  1116.  
  1117.     ULONG TeachFPGA(UBYTE,ULONG,APTR);
  1118.  
  1119.    FUNCTION
  1120.  
  1121.    INPUTS
  1122.     chip - chip number to define
  1123.  
  1124.     length - length of definition in bytes
  1125.  
  1126.     data - pointer to chip definition data
  1127.  
  1128.    RESULT
  1129.  
  1130.    EXAMPLE
  1131.  
  1132.    NOTES
  1133.  
  1134.    BUGS
  1135.  
  1136.    SEE ALSO
  1137.  
  1138. flyer.library/WriteEEreg                             flyer.library/WriteEEreg
  1139.  
  1140.    NAME
  1141.     WriteEEreg -- Write into Flyer's EEPROM
  1142.  
  1143.    SYNOPSIS
  1144.     error = WriteEEreg(board,addr,data)
  1145.     D0                 D0    D1   D2
  1146.  
  1147.     ULONG WriteEEreg(UBYTE,UBYTE,UWORD);
  1148.  
  1149.    FUNCTION
  1150.  
  1151.    INPUTS
  1152.     board - specifies the Flyer board (0-3)
  1153.  
  1154.     addr - address in EEPROM (0 - 63)
  1155.  
  1156.     data - data word to write
  1157.  
  1158.    RESULT
  1159.  
  1160.    EXAMPLE
  1161.  
  1162.    NOTES
  1163.  
  1164.    BUGS
  1165.  
  1166.    SEE ALSO
  1167.  
  1168.